Azure Load Testing (preview:2024-03-01)

2025/08/21 • 2 updated methods

LoadTestRun_CreateOrUpdateAppComponents (updated)
Description :  Add an app component to a test run by providing the resource Id, name and type.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_CreateOrUpdateAppComponents",
  "$parameters": [
    {
      "#name": "testRunId",
      "Description": {
        "new": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.",
        "old": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters."
      }
    }
  ]
}

⚼ Request

PATCH:  /test-runs/{testRunId}/app-components
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: App Component model. ,
Required: True ,
}
{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestRun_CreateOrUpdateServerMetricsConfig (updated)
Description :  Configure server metrics for a test run
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_CreateOrUpdateServerMetricsConfig",
  "$parameters": [
    {
      "#name": "testRunId",
      "Description": {
        "new": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.",
        "old": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters."
      }
    }
  ]
}

⚼ Request

PATCH:  /test-runs/{testRunId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: Server metric configuration model. ,
Required: True ,
}
{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}